Skip to main content
POST
[BETA] Campaign Performance Forecasts

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Body

application/json

Public API request for a listing campaign performance forecast.

campaignFormat
enum<string>
required

Campaign format type. Currently only 'listing' is supported.

Available options:
listing
dailyBudget
number
required

Daily budget for the campaign

dateRange
PublicDateRange · object
required

Campaign date range

targetRoas
number
required

Target Return on Ad Spend

campaignType
enum<string>
required

Campaign type (required)

Available options:
autobidding
products
PublicProductRequest · object[]
required

List of products in the campaign (required)

Minimum array length: 1
triggers
PublicTriggerRequest · object[]

List of campaign triggers (optional, defaults to empty list)

targets
enum<string>[] | null

Optional list of target variables to forecast. If not provided, all targets will be forecasted.

Available options:
ad_spend,
clicks,
impressions,
purchases,
sales

Response

Successful Response

forecasts
PublicCampaignForecastMetrics · object
required

Campaign performance forecasts